FHIR © HL7.org  |  Server Home  |  FHIR Server FHIR Server 3.4.11  |  FHIR Version n/a  User: [n/a]

Resource CapabilityStatement/FHIR Server from package fhir.hrsa.uds-plus#current (31 ms)

Package fhir.hrsa.uds-plus
Type CapabilityStatement
Id Id
FHIR Version R4
Source http://fhir.org/guides/hrsa/uds-plus/https://build.fhir.org/ig/drajer-health/uds-plus/CapabilityStatement-uds-plus-data-submitter-client.html
Url http://fhir.org/guides/hrsa/uds-plus/CapabilityStatement/uds-plus-data-submitter-client
Version 2.0.0
Status draft
Date 2020-12-06
Name UdsPlusDataSubmitter
Title Uds Plus Data Submitter CapabilityStatement
Experimental False
Realm us
Authority hl7
Description This is a CapabilityStatement that defines the expected capabilities of the Data Submitter actor.
Kind requirements

Resources that use this resource

No resources found


Resources that this resource uses

OperationDefinition
http://hl7.org/fhir/uv/bulkdata/OperationDefinition/group-export FHIR Bulk Data Group Level Export
import UDS Plus Import


Narrative

Note: links and images are rebased to the (stated) source

Data Receiver

(Requirements Definition Capability Statement)

Canonical URL: http://fhir.org/guides/hrsa/uds-plus/CapabilityStatement/uds-plus-data-submitter-client

Published by: HL7 International - Public Health Work Group

This is a CapabilityStatement that defines the expected capabilities of the Data Submitter actor as a client.

General

FHIR Version: 4.0.1
Supported formats: json

REST behavior

The primary focus of the Data Submitter actor as a client is to invoke the Group/$export operation identified below and extract the UDS+ data using US Core and QI Core profiles. In certain cases, the Data Submitter MAY have to invoke individual patient api's to extract the necessary UDS+ data when the Data Source does not support Group/$export operation. data.

Security:

Implementations must meet the general security requirements documented in FHIR Security guidance.

In addition the Data Submitter actor as a client needs to meet the security requirements as outlined in the SMART on FHIR Backend Services Authorization

Resource summary

Resource Search Read Read Version Instance History Resource History Create Update Delete
UDS+ profiles SHALL SHALL

FHIR Operations summary

As a client, the Data Submitter has to be capable of invoking the below operation on the Data Source.

As a client, the Data Submitter has to be capable of invoking the below operation on the Data Receiver to submit the manifest file.



UDS+ profiles

Profiles: All UDS+ profiles

Interactions

Name Description
  search

Search for specific UDS+ resource profile instances.

  read

Retrieve specific UDS+ resource profile instances




Source

{
  "resourceType" : "CapabilityStatement",
  "id" : "uds-plus-data-submitter-client",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <h2>Data Receiver</h2>\n <p>(Requirements Definition Capability Statement)</p>\n <p>Canonical URL: http://fhir.org/guides/hrsa/uds-plus/CapabilityStatement/uds-plus-data-submitter-client</p>\n <p>Published by: <b>HL7 International - Public Health Work Group</b>\n </p>\n <p>This is a CapabilityStatement that defines the expected capabilities of the Data Submitter actor as a client. \n </p>\n <h2>General</h2>\n <div class=\"table-wrapper\">\n <table>\n <tbody>\n <tr>\n <th>FHIR Version:</th>\n <td>4.0.1</td>\n </tr>\n <tr>\n <th>Supported formats:</th>\n <td>json</td>\n </tr>\n </tbody>\n </table>\n </div>\n <h2>REST behavior</h2>\n <p>The primary focus of the Data Submitter actor as a client is to invoke the Group/$export operation identified below and extract the UDS+ data using US Core and QI Core profiles.\n In certain cases, the Data Submitter MAY have to invoke individual patient api's to extract the necessary UDS+ data when the Data Source does not support Group/$export operation. \n data.\n </p>\n <p>\n <b>Security:</b>\n </p>\n <p>Implementations must meet the general security requirements documented in FHIR <a href=\"http://hl7.org/fhir/security.html\">Security guidance</a>.</p>\n <p>In addition the Data Submitter actor as a client needs to meet the security requirements as outlined in the <a href=\"spec.html#smart-on-fhir-backend-services-authorization\">SMART on FHIR Backend Services Authorization</a></p>\n \n <h3>Resource summary</h3>\n <div class=\"table-wrapper\">\n <table class=\"grid\">\n <thead>\n <tr>\n <th>Resource</th>\n <th>Search</th>\n <th>Read</th>\n <th>Read Version</th>\n <th>Instance History</th>\n <th>Resource History</th>\n <th>Create</th>\n <th>Update</th>\n <th>Delete</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>UDS+ profiles</th>\n <td>\n <a href=\"#UDS-search-type\" title=\"Search for specific UDS+ Resource instances.\">SHALL</a>\n </td>\n <td>\n <a href=\"#UDS-read\" title=\"Retrieve specific UDS+ Resource instances.\">SHALL</a>\n </td>\n <td>\n </td>\n <td> \n </td>\n <td>\n </td>\n <td>\n </td>\n <td>\n </td>\n\t\t\t <td>\n </td>\n </tr>\n \n </tbody>\n </table>\n </div>\n \n <h3>FHIR Operations summary</h3>\n <p>As a client, the Data Submitter has to be capable of invoking the below operation on the Data Source.</p>\n \n <ul>\n <li>\n <a href=\"http://hl7.org/fhir/uv/bulkdata/OperationDefinition-group-export.html\">Bulk Data Export ([BaseURL]/Group/[Id]/$export)</a>\n </li>\n </ul>\n \n <p>As a client, the Data Submitter has to be capable of invoking the below operation on the Data Receiver to submit the manifest file.</p>\n \n <ul>\n <li>\n <a href=\"OperationDefinition-import.html\">Bulk Data Import ([BaseURL]/$import)</a>\n </li>\n </ul>\n \n <br/>\n <br/>\n \n <h3>\n <a href=\"artifacts.html\">UDS+ profiles</a>\n </h3>\n <p>Profiles: All UDS+ profiles\n </p>\n <h4>Interactions</h4>\n <div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"UDS-search-type\">�</a>\n <span>search</span>\n </th>\n <td>\n <p>Search for specific UDS+ resource profile instances.</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"UDS-read\">�</a>\n <span>read</span>\n </th>\n <td>\n <p>Retrieve specific UDS+ resource profile instances</p>\n </td>\n </tr> \n </tbody>\n </table>\n </div>\n <br/>\n <br/> \n \n \n </div>"
  },
  "url" : "http://fhir.org/guides/hrsa/uds-plus/CapabilityStatement/uds-plus-data-submitter-client",
  "version" : "2.0.0",
  "name" : "UdsPlusDataSubmitter",
  "title" : "Uds Plus Data Submitter CapabilityStatement",
  "status" : "draft",
  "date" : "2020-12-06",
  "publisher" : "HRSA BPHC",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://bphc.hrsa.gov/"
        }
      ]
    }
  ],
  "description" : "This is a CapabilityStatement that defines the expected capabilities of the Data Submitter actor.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001"
        }
      ]
    }
  ],
  "kind" : "requirements",
  "fhirVersion" : "4.0.1",
  "format" : [
    "json"
  ],
  "rest" : [
    {
      "mode" : "client",
      "documentation" : "The primary focus of the Data Submitter is to invoke the Group/[id]/$export operation and gather the UDS+ data using US Core and QI Core profiles.",
      "security" : {
        "description" : "Implementations must meet the general security requirements documented in the security section of the implementation guide."
      },
      "operation" : [
        {
          "name" : "export",
          "definition" : "http://hl7.org/fhir/uv/bulkdata/OperationDefinition/group-export"
        },
        {
          "name" : "import",
          "definition" : "http://fhir.org/guides/hrsa/uds-plus/OperationDefinition/import"
        }
      ]
    }
  ]
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.